Friday, October 07, 2005

using NDoc with CC.NET

Below is a copy of the ndoc.build file I created. This will look for a coulple dll's, not all of them yet since it's a large project, and makes html and a .chm file. I was just trying to get something simple started and this is the beginning of it. Since I had a difficult time figuring out everything and I really couldn't find any good examples I figured I'd post this to help out others.


<?xml version="1.0"?>
<project default="ndoc">
<property name="debug" value="true"/>
<property name="Source" value="C:\Source" />


<target name="ndoc" depends="">
<ndoc verbose="true">
<assemblies basedir="${Source}">
<include name="${Source}\BusinessObjects\bin\Debug\BusinessObjects.dll" />
<include name="${Source}\ValueObjects\bin\Debug\ValueObjects.dll" />

</assemblies>


<!--
<summaries basedir="${TDD.Build}">
<include name="NamespaceSummary.xml" />
</summaries>-->
<documenters>
<documenter name="MSDN">
<property name="OutputDirectory" value="${TDD.Build}\doc" />
<property name="HtmlHelpName" value="My Help" />
<property name="HtmlHelpCompilerFilename" value="hhc.exe" />
<property name="IncludeFavorites" value="False" />
<property name="Title" value="Documentation for my web site and Web Services" />
<property name="SplitTOCs" value="False" />
<property name="DefaulTOC" value="" />
<property name="ShowVisualBasic" value="True" />
<property name="ShowMissingSummaries" value="True" />
<property name="ShowMissingRemarks" value="True" />
<property name="ShowMissingParams" value="True" />
<property name="ShowMissingReturns" value="True" />
<property name="ShowMissingValues" value="True" />
<property name="DocumentInternals" value="False" />
<property name="DocumentProtected" value="True" />
<property name="DocumentPrivates" value="False" />
<property name="DocumentEmptyNamespaces" value="False" />
<property name="IncludeAssemblyVersion" value="False" />
<property name="CopyrightText" value="" />
<property name="CopyrightHref" value="" />
</documenter>
</documenters>
</ndoc>

</target>

</project>


Then what I do is I run the above .build file from within my cruisecrontrol.net ccnet.config file using this

<nant>
<executable>C:\nant\bin\nant.exe</executable>
<buildFile>ndoc.build</buildFile>
<targetList>
<target>ndoc</target>
</targetList>
</nant>

No comments: